home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 7: Sunsite / Linux Cubed Series 7 - Sunsite Vol 1.iso / system / status / omnimoni.0 / omnimoni / OmniMoni / README < prev    next >
Encoding:
Text File  |  1995-11-12  |  4.4 KB  |  109 lines
  1. What is OmniMoni
  2. ----------------
  3.  
  4. OmniMoni is a highly configurable, realtime, information monitoring
  5. system.  It is written in Tcl/Tk and therefore requires a Tcl/Tk
  6. interpreter, usually wish.  It purpose is to display periodically
  7. updating textual messages in a user configurable format within a X
  8. window.  The unique idea behind OmniMoni is in two parts:
  9.  
  10. 1.  You tell OmniMoni exactly what information to monitor.  This
  11. provides almost infinite flexibility for anyone's needs.
  12.  
  13. 2.  OmniMoni can monitor that information in two main ways.  As text,
  14. formatted as desired in a window, or as a graph, solid or lined.
  15.  
  16. These two ideas will allow you to monitor almost anything you want to,
  17. in the way you want to.  The only catch is that the information must
  18. be gathered from some program that produces textual output.
  19. Fortunately, on UNIX type systems, there are many, many such programs.
  20. Additionally, using other programs such as perl, awk, and others, you
  21. can create a program to return what you want very easily.  Then
  22. OmniMoni can take the output from this new program and monitor it.
  23.  
  24. Regarding the version number.  This is version 1.0 and is not a beta
  25. release.  It has undergone a good bit of testing, but most of it has
  26. been at my own hands and not as thorough as I would have liked.
  27. Although I can not promise that it is bug free, I believe that it is
  28. stable and very useable.  I will also actively work to correct any
  29. bugs that do come up, so please report them to me.
  30.  
  31.  
  32.  
  33. Getting Started
  34. ---------------
  35.  
  36. Since OmniMoni is written in Tcl/Tk it requires a Tcl/Tk interpreter.
  37. The most common one is called wish.  It comes with the Tcl/Tk package
  38. which is available from at the official Tcl/Tk site
  39. ftp:://ftp.cs.berkeley.edu/ucb.tcl.
  40.  
  41. There are many sites that carry this package, though, so you might
  42. want to find one close to you.
  43.  
  44. Once you have wish installed correctly on you system you should only
  45. need to type "./omnimoni -f omnirc" to get a glimpse of what OmniMoni
  46. can do.  This runs OmniMoni with the configuration file "omnirc".
  47. This configuration file derives a lot of information from the /proc
  48. filesystem which is part of Linux (a Unix like OS for x86 machines).
  49. It is my "working" configuration file.  This means it is more for my
  50. testing things than for use.  It is, however, relatively complex, and
  51. therefore interesting.  If you are running on another OS, I recommend
  52. running "Demonstration".  This script will go through progressively
  53. more complex configurations one at a time.  Most of these
  54. configurations should work on a variety of operating systems.
  55.  
  56. For complete information on OmniMoni, especially regarding how to
  57. create you own configuration files, read the man page and look at the
  58. sample configuation files in the demos directory.  There is no other
  59. documentation with the program since the man page is rather extensive.
  60.  
  61.  
  62.  
  63. Questions?  Comments!
  64. ---------------------
  65.  
  66. If you have any feedback you wish to give me, be it questions,
  67. comments, suggestions, whatever, please email them to:
  68.  
  69. rvm@fore.com
  70.  
  71. Also, if you have created any useful configuration files that you
  72. think someone might like please email them to me and I will make them
  73. publicly available and perhaps I'll use them in future demonstration
  74. scripts.  This archive is at ftp://shrine.cyber.ad.jp/~rvm/OmniMoni.
  75.  
  76.  
  77.  
  78. Legal Stuff
  79. -----------
  80.  
  81. OmniMoni is a highly configurable, realtime, information monitoring system.
  82. OmniMoni, Copyright (C) 1995  Rainer Mager
  83.  
  84. This program is free software; you can redistribute it and/or modify it
  85. under the terms of the GNU General Public License as published by the Free
  86. Software Foundation; either version 2 of the License, or (at your option)
  87. any later version.
  88.  
  89. This program is distributed in the hope that it will be useful, but WITHOUT
  90. ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  91. FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  92. more details.
  93.  
  94. You should have received a copy of the GNU General Public License along with
  95. this program; if not, write to the Free Software Foundation, Inc., 675 Mass
  96. Ave, Cambridge, MA 02139, USA.
  97.  
  98.  
  99.  
  100. Appreciations
  101. -------------
  102.  
  103. I would like to give my great thanks to everyong who has contributed
  104. to this in any way.  This includes the generous people on
  105. comp.lang.tcl who patiently responded to my questions, to the initial
  106. pre-beta testers for struggling through the bugs, the public beta
  107. testers for their comments and suggestions, the Linux community, and
  108. everyone behind the Tcl/Tk effort.
  109.